/*
 * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.dv8tion.jda.api.events.entitlement;

import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.entities.Entitlement;
import net.dv8tion.jda.api.events.Event;

import javax.annotation.Nonnull;

/**
 * Indicates that an {@link Entitlement Entitlement} was either created, updated, or deleted
 *
 * @see EntitlementCreateEvent
 * @see EntitlementUpdateEvent
 * @see EntitlementDeleteEvent
 */
public abstract class GenericEntitlementEvent extends Event {
    protected final Entitlement entitlement;

    protected GenericEntitlementEvent(@Nonnull JDA api, long responseNumber, @Nonnull Entitlement entitlement) {
        super(api, responseNumber);
        this.entitlement = entitlement;
    }

    /**
     * The {@link Entitlement Entitlement}
     *
     * @return The {@link Entitlement Entitlement}
     */
    @Nonnull
    public Entitlement getEntitlement() {
        return entitlement;
    }
}
